gridpack::ymatrix::YMBus Class Reference

#include <ymatrix_components.hpp>

Inheritance diagram for gridpack::ymatrix::YMBus:

[legend]

Collaboration diagram for gridpack::ymatrix::YMBus:

[legend]

List of all members.

Public Member Functions
	YMBus (void)
	~YMBus (void)
bool	matrixDiagSize (int *isize, int *jsize) const
bool	matrixDiagValues (ComplexType *values)
void	setYBus (void)
void	setYBusDiag (double rval, double ival)
gridpack::ComplexType	getYBus (void)
void	load (const boost::shared_ptr< gridpack::component::DataCollection > &data)
void	setMode (int mode)
bool	isIsolated (void) const
void	setIsolated (const bool flag)
void	getShuntValues (double *bl, double *gl) const
void	setParam (std::string name, double value, int idx)

---

Constructor & Destructor Documentation

gridpack::ymatrix::YMBus::YMBus

(

void

)

Simple constructor

gridpack::ymatrix::YMBus::~YMBus

(

void

)

Simple destructor

---

Member Function Documentation

void gridpack::ymatrix::YMBus::getShuntValues	(	double *	bl,
		double *	gl
	)			const

Get shunt values

Parameters:

	gl	shunt GL value
	bl	shunt BL value

gridpack::ComplexType gridpack::ymatrix::YMBus::getYBus

(

void

)

Get values of YBus matrix. These can then be used in subsequent calculations

Reimplemented in gridpack::powerflow::PFBus, and gridpack::state_estimation::SEBus.

bool gridpack::ymatrix::YMBus::isIsolated

(

void

)

const

Return whether or not a bus is isolated

Returns:

true if bus is isolated

Reimplemented in gridpack::state_estimation::SEBus.

void gridpack::ymatrix::YMBus::load

(

const boost::shared_ptr< gridpack::component::DataCollection > &

data

)

[virtual]

Load values stored in DataCollection object into YMBus object. The DataCollection object will have been filled when the network was created from an external configuration file

Parameters:

data,:

DataCollection object contain parameters relevant to this bus that were read in when network was initialized

Reimplemented from gridpack::component::BaseComponent.

Reimplemented in gridpack::powerflow::PFBus, and gridpack::state_estimation::SEBus.

bool gridpack::ymatrix::YMBus::matrixDiagSize	(	int *	isize,
		int *	jsize
	)			const [virtual]

Return size of matrix block on the diagonal contributed by component

Parameters:

isize,jsize,:

number of rows and columns of matrix block

Returns:

: false if network component does not contribute matrix element

Reimplemented from gridpack::component::MatVecInterface.

Reimplemented in gridpack::powerflow::PFBus, and gridpack::state_estimation::SEBus.

bool gridpack::ymatrix::YMBus::matrixDiagValues

(

ComplexType *

values

)

[virtual]

Return the values of for a diagonal matrix block. The values are returned in row-major order

Parameters:

values,:

pointer to matrix block values

Returns:

: false if network component does not contribute matrix element

Reimplemented from gridpack::component::MatVecInterface.

Reimplemented in gridpack::powerflow::PFBus, and gridpack::state_estimation::SEBus.

void gridpack::ymatrix::YMBus::setIsolated

(

const bool

flag

)

Change isolated status of bus

Parameters:

flag

true if bus is isolated

void gridpack::ymatrix::YMBus::setMode

(

int

mode

)

[virtual]

Set the mode to control what matrices and vectors are built when using the mapper

Parameters:

mode,:

enumerated constant for different modes

Reimplemented from gridpack::component::BaseComponent.

Reimplemented in gridpack::powerflow::PFBus, and gridpack::state_estimation::SEBus.

void gridpack::ymatrix::YMBus::setParam	(	std::string	name,
		double	value,
		int	idx
	)

Set internal parameters inside the Y-bus component

Parameters:

	name	character string describing component to be modified
	value	of parameter to be modified
	idx	index (if necessary) of variable to be modified

void gridpack::ymatrix::YMBus::setYBus

(

void

)

Set values of YBus matrix. These can then be used in subsequent calculations

Reimplemented in gridpack::powerflow::PFBus, and gridpack::state_estimation::SEBus.

void gridpack::ymatrix::YMBus::setYBusDiag	(	double	rval,
		double	ival
	)

Modify diagonal values of matrix.

Parameters:

	rval	real part of diagonal matrix element
	ival	imaginary part of diagonal matrix element

---

The documentation for this class was generated from the following file:

• ymatrix_components.hpp